Skip to content

Conversation

@aninibread
Copy link
Contributor

Summary

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 17, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Added new documentation for the AutoRAG feature, including concepts, configuration, and a getting started guide.

  • Introduced new concept documentation on how AutoRAG works and its key concepts.
  • Added configuration details for Workers binding and Pages Functions.
  • Created a getting started guide for AutoRAG, outlining setup and usage steps.

Added Files

  • src/content/docs/autorag/concepts/how-autorag-works.mdx
  • src/content/docs/autorag/concepts/index.mdx
  • src/content/docs/autorag/configuration/index.mdx
  • src/content/docs/autorag/configuration/workers-binding.mdx
  • src/content/docs/autorag/get-started.mdx
  • src/content/docs/autorag/index.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 17, 2025

Preview URL: https://c0463615.preview.developers.cloudflare.com
Preview Branch URL: https://anni-autorag-new.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers-ai/guides/tutorials/build-a-retrieval-augmented-generation-ai/ https://anni-autorag-new.preview.developers.cloudflare.com/workers-ai/guides/tutorials/build-a-retrieval-augmented-generation-ai/
https://developers.cloudflare.com/autorag/tutorial/brower-rendering-autorag-tutorial/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/tutorial/brower-rendering-autorag-tutorial/
https://developers.cloudflare.com/workers-ai/markdown-conversion/ https://anni-autorag-new.preview.developers.cloudflare.com/workers-ai/markdown-conversion/
https://developers.cloudflare.com/autorag/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/
https://developers.cloudflare.com/autorag/configuration/system-prompt/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/configuration/system-prompt/
https://developers.cloudflare.com/autorag/usage/rest-api/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/usage/rest-api/
https://developers.cloudflare.com/autorag/usage/workers-binding/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/usage/workers-binding/
https://developers.cloudflare.com/vectorize/ https://anni-autorag-new.preview.developers.cloudflare.com/vectorize/
https://developers.cloudflare.com/autorag/get-started/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/get-started/
https://developers.cloudflare.com/autorag/configuration/cache/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/configuration/cache/
https://developers.cloudflare.com/autorag/configuration/chunking/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/configuration/chunking/
https://developers.cloudflare.com/autorag/concepts/how-autorag-works/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/concepts/how-autorag-works/
https://developers.cloudflare.com/autorag/configuration/retrieval-configuration/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/configuration/retrieval-configuration/
https://developers.cloudflare.com/autorag/concepts/what-is-rag/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/concepts/what-is-rag/
https://developers.cloudflare.com/autorag/configuration/query-rewriting/ https://anni-autorag-new.preview.developers.cloudflare.com/autorag/configuration/query-rewriting/

@aninibread aninibread marked this pull request as ready for review April 1, 2025 18:12
@aninibread aninibread requested a review from a team as a code owner April 1, 2025 18:12
@aninibread

This comment was marked as resolved.

@aninibread aninibread merged commit 8d6ada8 into production Apr 6, 2025
9 checks passed
@aninibread aninibread deleted the anni/autorag-new branch April 6, 2025 23:41
elithrar pushed a commit that referenced this pull request Apr 6, 2025
* New autrag product section

* Added placeholder file to new autorag folder

* Added Overview and Get Started files with frontmatter

* made autorag not capitalized

* lowercase

* Delete src/content/docs/AutoRAG/autorag.mdx

* Delete src/content/docs/AutoRAG/index.mdx

* Update src/content/docs/autorag/autorag.mdx

* Update src/content/docs/autorag/autorag.mdx

* Rename autorag.mdx to get-started.mdx

* removed externals and algolia from yaml

* Update src/content/docs/autorag/index.mdx

* getting started + bindings

* Update src/content/docs/autorag/get-started.mdx

Co-authored-by: Brendan Irvine-Broque <[email protected]>

* Update src/content/docs/autorag/get-started.mdx

Co-authored-by: Brendan Irvine-Broque <[email protected]>

* progress

* progress 2

* progress 3

* completed content

* mostly there

* fix link

* deep link and small fixes

* added response structure

* small fix

* fix

* pricing

* Update how-autorag-works.mdx

fixed spelling mistake

* fix general structure and small issues

* add references

* added image fix links

* Update src/content/docs/autorag/platform/release-note.mdx

Co-authored-by: ToriLindsay <[email protected]>

* small fix

* remove extra link

* Apply suggestions from code review

Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: Kody Jackson <[email protected]>

* Apply suggestions from code review

Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: Kody Jackson <[email protected]>

* index edit

* small fixes

* Update src/content/docs/autorag/how-autorag-works.mdx

Co-authored-by: ToriLindsay <[email protected]>

* Update how-autorag-works.mdx

* edits for new content / structure

* add tutorials

* Update src/content/docs/autorag/platform/limits-pricing.mdx

* binding fix and changelog addition

* fix doc recommendation

* better wording in cache

* autorag changelog

* final fixes

---------

Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: Brendan Irvine-Broque <[email protected]>
Co-authored-by: Kathy <[email protected]>
Co-authored-by: kodster28 <[email protected]>
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* New autrag product section

* Added placeholder file to new autorag folder

* Added Overview and Get Started files with frontmatter

* made autorag not capitalized

* lowercase

* Delete src/content/docs/AutoRAG/autorag.mdx

* Delete src/content/docs/AutoRAG/index.mdx

* Update src/content/docs/autorag/autorag.mdx

* Update src/content/docs/autorag/autorag.mdx

* Rename autorag.mdx to get-started.mdx

* removed externals and algolia from yaml

* Update src/content/docs/autorag/index.mdx

* getting started + bindings

* Update src/content/docs/autorag/get-started.mdx

Co-authored-by: Brendan Irvine-Broque <[email protected]>

* Update src/content/docs/autorag/get-started.mdx

Co-authored-by: Brendan Irvine-Broque <[email protected]>

* progress

* progress 2

* progress 3

* completed content

* mostly there

* fix link

* deep link and small fixes

* added response structure

* small fix

* fix

* pricing

* Update how-autorag-works.mdx

fixed spelling mistake

* fix general structure and small issues

* add references

* added image fix links

* Update src/content/docs/autorag/platform/release-note.mdx

Co-authored-by: ToriLindsay <[email protected]>

* small fix

* remove extra link

* Apply suggestions from code review

Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: Kody Jackson <[email protected]>

* Apply suggestions from code review

Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: Kody Jackson <[email protected]>

* index edit

* small fixes

* Update src/content/docs/autorag/how-autorag-works.mdx

Co-authored-by: ToriLindsay <[email protected]>

* Update how-autorag-works.mdx

* edits for new content / structure

* add tutorials

* Update src/content/docs/autorag/platform/limits-pricing.mdx

* binding fix and changelog addition

* fix doc recommendation

* better wording in cache

* autorag changelog

* final fixes

---------

Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: Brendan Irvine-Broque <[email protected]>
Co-authored-by: Kathy <[email protected]>
Co-authored-by: kodster28 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:AutoRAG product:reference-architecture product:vectorize Vectorize: https://developers.cloudflare.com/vectorize/ product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/ size/xl

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants